Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Contribution Policy #1470

Merged
merged 4 commits into from
Jun 13, 2024
Merged

Contribution Policy #1470

merged 4 commits into from
Jun 13, 2024

Conversation

jafeltra
Copy link
Collaborator

@jafeltra jafeltra commented Jun 12, 2024 •
edited
Loading

This PR adds a Contribution Policy for SUSHI. This includes a CONTRIBUTING.md file and a CODE-OF-CONDUCT.md file.

The Code of Conduct comes from https://www.contributor-covenant.org/. They mentioned there is a badge, so I added it, but it isn't required. If you look at the branch in the main code viewer, you can see the badge in the README and see the top-level link that GitHub adds for the Code of Conduct at the top of the README viewer.

One other note: these files are both in the root of the repository, but I learned that you can alternatively add them to the .github directory. That's actually where the github docs repo has these files. On one hand, it keeps these types of files all in one place. On the other hand, they're a little less discoverable. Let me know if anyone has an opinion on the placement.

@cmoesel
Copy link
Member

cmoesel commented Jun 12, 2024

Thanks, Julia. This looks great -- and I think that potential contributors will really appreciate it! I also like the Code of Conduct badge and tab.

As for the location of the files, I prefer having them in the root directory of the project so that others easily notice them. Up until today, I wouldn't have thought of looking in .github for files like this.

mint-thompson
mint-thompson reviewed Jun 12, 2024
View reviewed changes
Copy link
Collaborator

@mint-thompson mint-thompson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new code of conduct and contribution policy look good! Thank you!

@jafeltra
Copy link
Collaborator Author

@cmoesel and @mint-thompson: I made some small tweaks based on feedback from @KaelynJefferson. Let me know what you think.

Also, I just wanted to call out two other thoughts to make sure we had considered:

  • The CONTRIBUTING document refers to "maintainers". Since there will be specific roles defined for the FSH project, if that term is overloaded now, I can update its use.
  • We will need a contact for the CODE-OF-CONDUCT file for reporting issues. I left the placeholder for now, but we will need to update this to a real contact before we finalize this document.

@cmoesel
Copy link
Member

cmoesel commented Jun 13, 2024

@jafeltra HL7 has reviewed it and noted that we should use the HL7 Code of Conduct instead of the one we're currently pointing to. Please:

  • Update CONTRIBUTING to point to the HL7 Code of Conduct
  • Update CODE-OF-CONDUCT to include a link to the HL7 Code of Conduct. Perhaps something as simple as:

    To ensure a welcoming environment, we follow the HL7 Code of Conduct and expect contributors to do the same. For your convenience, a copy of the HL7 Code of Conduct, as of June 2024, is included below. Please visit the official HL7 Code of Conduct for the most recent version.

    (HL7 Code of Conduct text goes here...)

@cmoesel
Copy link
Member

cmoesel commented Jun 13, 2024

Just documenting what we discussed in our 1:1: It's sufficient to have the CODE-OF-CONDUCT file link to the HL7 Code of Conduct without copying all its text.

@jafeltra
Copy link
Collaborator Author

@cmoesel - I just updated this PR with the feedback from HL7 and the approach you noted above.

@jafeltra jafeltra marked this pull request as ready for review June 13, 2024 18:18
cmoesel
cmoesel approved these changes Jun 13, 2024
View reviewed changes
Copy link
Member

@cmoesel cmoesel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. Thank you, @jafeltra. At this point you can add variations of these to the remaining repos:

  • GoFSH
  • FHIR Package Loader
  • FSH Online
  • FSH Online Examples
  • FSH School Site
  • FSH VS Code Extension

Thanks!
Chris

@cmoesel cmoesel merged commit dc139e8 into master Jun 13, 2024
14 checks passed
@cmoesel cmoesel deleted the contribution-policy branch June 13, 2024 19:35
KaelynJefferson pushed a commit that referenced this pull request Jun 14, 2024
@jafeltra @KaelynJefferson
Contribution Policy (#1470)
5ccab5d 
* Add CONTRIBUTING.md and CODE-OF-CONDUCT.md with badge

* Small tweaks

* Use HL7 Code of Conduct
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mint-thompson mint-thompson mint-thompson left review comments

@cmoesel cmoesel cmoesel approved these changes

@KaelynJefferson KaelynJefferson Awaiting requested review from KaelynJefferson

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jafeltra @cmoesel @mint-thompson